Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test non-empty IndexSet.limitSpanningRange, documenting why max is inside #4

Merged
merged 3 commits into from
Aug 6, 2023

Conversation

DivineDominion
Copy link
Contributor

Looking at the implementation, I wondered if ... instead of ..< was intentional -- but writing the test showed that, yes of course I want the largest element to be part of the range :)

@mattmassicotte
Copy link
Collaborator

I'm very very very into test- and documentation-only PRs!

But I do have one suggestion. I think it fits better with convention when the first doc line is more succinct. Do you think it would be possible to keep that shorter and move the additional info into the discussion section?

@DivineDominion
Copy link
Contributor Author

Oh yeah, makes sense to keep the first line shorter.

Maybe the doc-comment part can also be dropped since this sounds like a trivial 'insight' even though it took me a minute to realize this. The tests might be sufficient to self-document the behavior, though, depending on your tastes :)

@mattmassicotte mattmassicotte merged commit 6a7bdc2 into ChimeHQ:main Aug 6, 2023
4 checks passed
@mattmassicotte
Copy link
Collaborator

Nah, I like it! Thank you so much.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants